railcards-eapi

Whilst every effort will be made to capture all errors which may be returned for these API resources on this page, if you are returned an error not recorded here, please provide details to RDG, including the request which generated the error and the error message itself, and we will investigate and add to this page.

Platform Error Format

The Developer Portal will return an error if submitted requests do not comply with one or more of an API's policies. A common example of this is the security policy, which requires a valid JWT in every request. If the request doesn't include a valid JWT then the Portal will reject the request immediately and make no attempt to process it. Rejected requests of this nature will result in a platform error, which has the following simple format (See Platform Error Object data type):

{
    "error" : "error message"
}

RDG Error format

If a request passes the policy checks it will be submitted to the relevant RDG API which may then result in an RDG specific error as opposed to a generic platform error. APIs on the RDG Developer Portal use the following common error format to contain and return these errors to consumers (See RDG Error Object data type):

{
    "errors": [
    {
        "code": "error_code",
        "message": "error message",
        "timestamp": "YYYY-MM-DDTHH:MM:SS",
        "context":
        {
            "{key}": "value"
        }
    }
    ]
}

The context object is an unspecified list of key value pairs, allowing new context information to be provided without requiring a schema change.
There are currently no context fields added to Railcard Errors.

Known Error Cases

General

Railcards

Last update: 02-Feb-2023 11.30: ASSIST API Documentation Maintenance: railcards-eapi | Version: v1 | Page: Error handling| Revision: A.

To request updates to this text please contact Neil Barkham.